XIQS Get Card Event List

From IQsimWiki

Jump to: navigation, search

XIQS Get Card Event List - Sim Card Management

Description
getXIQSCardSyncList ( [ Long id_partition ] [, filter f ] )
Get the list of sim card credit synchro owned by this partition. In the case the current logged user is administrator, he gets the full list of all available Sim Card objects unless a 'partition id' parameter is specified.
Parameters
[ Long id_partition ]
Partition Id
[ filter f ]
Return Values
List of Sim Card synchro events owned by this partition

Long id - SIM Card Id

String imsi - SIM Card International Mobile Subscriber Identifier (IMSI)

Until API 1.2.0:

String status - SIM Status ("INITIALIZING", "INITIALIZED", "REGISTERED_OUT_PAUSED", "REGISTERED", "ERR_SIM_PIN_FAIL", "ERR_SIM_PUK", "ERR_SIM_NOT_READY", "ERR_SIM_NEW_DETECTED", "NOT_REGISTERED", "ERR_FIRM_UPDATING", "ERR_FIRM_UPDATED", "ERR_FIRM_UPDATE_FAIL", "ERR_SIM_PIN_WAITING", "ERR_SIM_PIN_FAIL_WAITING")

Since API 1.3.0:

Long status - SIM Status

API 1.3.0 SIM Status details
The new Sim Status is an unsigned 32 bits value encoded on a high 16bits part for general status and a low 16bits part for detailed status or error codes.

In most high level language, the general status (hi) and detailed status (low) should be obtained as is:
int iGeneralStatus = ( dwSimCardStatus >> 16 );
int iDetailedStatus = ( dwSimCardStatus & 0xFF );
The high part or general status is one of following values:

  • 0x00 = EMPTY : The SIM Status is unknown.
  • 0x01 = BEZEN2 : Sim is disabled and cannot be used from the system. Administrator must reactivate and makes the Sim available in order to use it.
  • 0x02 = BLACK_BLINK : Sim is being processed from Sim Manager to be allocated.
  • 0x03 = GREEN : Sim is currently registered to the mobile network.
  • 0x04 = GREEN_LIGHT : Sim has been virtualized and is ready to be used by the device.
  • 0x05 = GREEN_LIGHT_BLINK : Sim is being allocated to port. Information to connect to the Sim Rack and the Sim slot are being transferred to the device.
  • 0x06 = ERROR : Sim is idle and available for allocation.
  • 0x07 = ERROR2 : Sim has been recorded once in the database but is not present anymore in the system. It has been removed from Sim Rack.
  • 0x08 = EURO : Sim need to be recharged.
  • 0x09 = EXCLAMATION : Status is unknown as Sim Manager has lost connection from the device using the Sim.
  • 0x0A = EXCLAMATION_BLANC : Status is unknown as Sim Manager has lost connection from the Sim Rack and the device using the Sim.
  • 0x0B = YELLOW : Sim is currently in pause. Sim will be available after ending the pause.
  • 0x0C = ORANGE : Sim is currently registered to the mobile network and being in low credit.
  • 0x0D = RED : Sim is currently registered to the mobile network and using credit over the plan (postpaid Sim only).


The low part or status details is one of following values:

  • 0x00 = EMPTY : The SIM Status details is undefined
  • 0x01 = SIM_REGISTERED
  • 0x02 = SIM_ALLOCATED
  • 0x03 = SIM_NOTREGISTERED
  • 0x04 = SIM_WRONGPINCODE
  • 0x05 = SIM_PUKCODE
  • 0x06 = SIM_PINCODEWAITING
  • 0x07 = SIM_UNREACHABLERACK
  • 0x08 = SIM_TOBERECHARGED
  • 0x09 = SIM_ASSIGNING
  • 0x0A = LOW_DURATION_DETECTION
  • 0x0B = SIM_MAXASSIGNATION
  • 0x0C = SIM_MAXSUCCESSIVE
  • 0x0D = SIM_NOMORECREDIT
  • 0x0E = SIM_REFILLFAILED
  • 0x0F = SIM_TOBEACTIVATED
  • 0x10 = SIM_ACTIVATIONFAILED
  • 0x11 = SIM_CREDITSYNCMISMATCH
  • 0x12 = SIM_SLIDMISSING
  • 0x13 = SIM_SIMTRANSFER
  • 0x14 = SIM_PAUSED
  • 0x15 = SIM_MAXCONSSMSSENDING
  • 0x16 = SIM_CREDITDEAC
  • 0x17 = SIM_LOWDURATION
  • 0x18 = SIM_AREACODECTL
  • 0x19 = SIM_DEACTIVMANUAL
  • 0x1A = SIM_REMAIN_CALL_ALERT
  • 0x1B = SIM_REMAIN_CALLOFF_ALERT
  • 0x1C = SIM_REMAIN_CALLBONUS_ALERT
  • 0x1D = SIM_REMAIN_SMS_ALERT
  • 0x1E = SIM_REMAIN_SMSOFF_ALERT
  • 0x1F = SIM_REMAIN_SMSBONUS_ALERT
  • 0x20 = SIM_REMAIN_SMSCALL_ALERT

Long id_partition - Partition Id

Long ussdate -

String ussresponse -

Integer ussresult -

String ussparsedresponse -

String ussresponse2 -

String ussparsedresponse2 -

Integer ussstatus -

Long usspeak -

Long ussoffpeak -

Long occpeak -

Long occoffpeak -

Long bonus -

Long occbonus -

Long smspeak -

Long smsoffpeak -

Long smsoccpeak -

Long smsoccoffpeak -

Long smsbonus -

Long smsoccbonus -

String ppname - Price Plan name

String ussdcmd -

Integer advantage0 -

Integer advantage1 -

String provider - GSM Operator name

Long remainmin - Remaining Peak minutes

Long remainmin_off - Remaining Off Peak minutes

Long remainminbonus - Remaining bonus minutes

Long remainsms - Remaining Peak sms

Long remainsms_off - Remaining Off Peak sms

Long remainsmsbonus - Remaining bonus sms

Long id_operator - GSM Operator Id

Long id_pplan - Price Plan Id

Long countrycode -

String iccid - SIM card Integrated Circuit Card ID (ICCID)

Integer disabled - Disable SIM card flag

Long lastreload - Credit last modification

Integer creditcheckmethod - Method used for creditcheck

Error Data structure ( Error Management )

Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB

See Also
Personal tools
Namespaces
Variants
Views
Actions
Navigation
XIQS XML Protocol
XIQS Framework Libraries
XIQS Command List